ENVI::PingRepository

The PingRepository method verifies if a valid ENVI Repository server is listening and working as expected.

Syntax

Result = ENVI.PingRepository(URL [, ERROR=value])

Return Value

If the server is valid and can be reached, a hash containing some details about the repository server, for example:

{

"name": "ENVI Repository",

"version": "1.0.0",

"started": "2025-01-08T06:54:19.7466773-07:00",

"packages_stored": 35,

"database": "sqlite",

"storage": "filesystem"

}

If the server is not valid or cannot be reached, a !null value.

Arguments

URL

Specify a fully qualified URL for the ENVI Repository to ping.

Keywords

ERROR

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

Version History

ENVI 6.2

Introduced

See Also

ENVI::DeleteLocalRepository, ENVI::DownloadFromRepository, ENVI::EditRepositoryPackage, ENVI::GetLocalPackageInfo, ENVI::PublishToRepository, ENVI::RegisterRepository, ENVI::UnregisterRepository